Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add installation, cluster setup, emojivoto demo; fix mdx component mapping, prism theme #266

Merged
merged 6 commits into from
Mar 26, 2024

Conversation

katexochen
Copy link
Member

@katexochen katexochen commented Mar 20, 2024

Adding the first parts of our user-facing documentation.

@katexochen katexochen added the documentation Improvements for user docs label Mar 20, 2024
Copy link

github-actions bot commented Mar 20, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-03-26 09:07 UTC

Copy link
Contributor

@burgerdev burgerdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
--os-sku AzureLinux \
--node-vm-size Standard_DC4as_cc_v5 \
--node-count 1 \
--generate-ssh-keys
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need these?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In our dev-setup--yes. But I forgot for what exactly, so not sure if strictly required for users. Better keep it for now just in case...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found it: https://learn.microsoft.com/en-us/azure/aks/manage-ssh-node-access?tabs=node-shell#create-an-aks-cluster-with-ssh-keys

If no parameters are specified, the Azure CLI defaults to referencing the SSH keys stored in the ~/.ssh/id_rsa.pub file. If the keys aren't found, the command returns the message An RSA key file or key value must be supplied to SSH Key Value.

I believe the "right" argument for our CI would be --no-ssh-key. For the user docs generate-ssh-keys makes sense, I guess.

docs/docs/getting-started/cluster-setup.md Outdated Show resolved Hide resolved
docs/docs/getting-started/install.md Outdated Show resolved Hide resolved
docs/docs/intro.md Outdated Show resolved Hide resolved
docs/docs/intro.md Outdated Show resolved Hide resolved
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Copy link
Member

@m1ghtym0 m1ghtym0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Just some minor nits.

docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
docs/docs/examples/emojivoto.md Outdated Show resolved Hide resolved
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
@katexochen katexochen merged commit b860b1f into main Mar 26, 2024
8 checks passed
@katexochen katexochen deleted the p/docs-content branch March 26, 2024 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements for user docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants